Withdraw

This operation transfers the certifier's decision to withdraw the Certificate Registration application from the Online Certificate Registration Service to the council's IT system.

path Parameters
CaseID
required
string

A fully qualified application number or case id

header Parameters
OrganisationID
required
string

Used by the API gateway to route the request to the council's API endpoint

IdempotencyId
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json

Information request object

caseStatus
required
string non-empty

Status of the case

withdrawalDate
required
string <date> non-empty

Date of withdrawal

required
object (Person)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "Withdrawn",
  • "withdrawalDate": "2019-08-24",
  • "updatedBy": {
    }
}
Next to UpdateAdditionalInfo